Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Modify url in example/1-quickstart.ipynb #215

Merged
merged 2 commits into from
Sep 11, 2024

Conversation

falconlee236
Copy link
Contributor

Description

Modify Full documentation url latest to stable in example/1-quickstart.ipynb

Motivation and Context

When I click that url

Environment, Policy and Model
Full documentation of:

Base environment class [here](https://rl4co.readthedocs.io/en/latest/_content/api/envs/base.html)
Base policy class [here](https://rl4co.readthedocs.io/en/latest/_content/api/models/base.html)
Base model class [here](https://rl4co.readthedocs.io/en/latest/_content/api/algos/base.html)

the website shows this page
Screen Shot 2024-09-11 at 3 24 37 PM

this cannot access rl4co's official docs directly, so i change latest url to corresponding stable url.

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Remove all that do not apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of examples)

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.

@fedebotu
Copy link
Member

Hi @falconlee236 , thanks for spotting this!

Could you replace the ReadTheDocs URLs with the new rl4.co website instead? For example:

https://rl4co.readthedocs.io/en/stable/docs/content/api/envs/base --> https://rl4.co/docs/content/api/envs/base/

@falconlee236
Copy link
Contributor Author

falconlee236 commented Sep 11, 2024

Hi @falconlee236 , thanks for spotting this!

Could you replace the ReadTheDocs URLs with the new rl4.co website instead? For example:

https://rl4co.readthedocs.io/en/stable/docs/content/api/envs/base --> https://rl4.co/docs/content/api/envs/base/

Okay, I change the url soon

@falconlee236
Copy link
Contributor Author

Hi @falconlee236 , thanks for spotting this!
Could you replace the ReadTheDocs URLs with the new rl4.co website instead? For example:
https://rl4co.readthedocs.io/en/stable/docs/content/api/envs/base --> https://rl4.co/docs/content/api/envs/base/

Okay, I change the url soon

Can you see my commit? @fedebotu

@fedebotu
Copy link
Member

Yup, merging now. Thanks!

@fedebotu fedebotu merged commit 09f91ba into ai4co:main Sep 11, 2024
@falconlee236 falconlee236 deleted the fix-examples-url branch September 11, 2024 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants